IRIX Base Documentation 2002 November

home *** CD-ROM | disk | FTP | other *** search

/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat4 / pod.z / pod

Wrap

Text File | 2002-10-03 | 46.8 KB | 859 lines

PPPPOOOODDDD((((4444)))) IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo PPPPOOOODDDD((((4444)))) NNNNAAAAMMMMEEEE pod - Printer Object Database (POD) file formats DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN This manual page details the formats for the Printer Object Database (POD) files. The POD contains information on the current configuration, status and job history of a single printer. Each printer physically installed on a system maintains its own POD. An initial set of POD files is created by the printer driver developer and installed on the system. This initial set of POD files must include a config file representing the capabilities of the printer, a status file indicating a typical printing state and an empty log file. All subsequent interaction with the POD is done through the _l_i_b_p_o_d(_3) API. The API provides network transparent, mediated access to the POD files. A Printer Object Database consists of three separate ASCII text files. There is one set of these files for each printer physically installed on a system. The name of each POD file is formed from the printer name and the suffix ._c_o_n_f_i_g, ._s_t_a_t_u_s and ._l_o_g, respectively. All POD files are located in the directory ////vvvvaaaarrrr////ssssppppoooooooollll////llllpppp////ppppoooodddd. The information contained in each file is summarized below and explained in detail in subsequent sections. <<<<pppprrrriiiinnnntttteeeerrrr nnnnaaaammmmeeee>>>>....ccccoooonnnnffffiiiigggg This file contains detailed information on the printer's capabilities. The file is created by the driver developer to characterize the printer's capabilities. For example, the possible paper sizes, printer location and available fonts are all specified in this file. Typically the information in the config file does not change over time. Printer filters and drivers treat the config file as read-only. The printer install tools may modify the config file at printer installation time to enter site specific information (e.g. printer location) or note the presence of optional equipment (e.g. duplex option or envelope feeder). <<<<pppprrrriiiinnnntttteeeerrrr nnnnaaaammmmeeee>>>>....ssssttttaaaattttuuuussss This file contains information about the current operational status of the printer. The information in the file indicates whether the printer is busy, what type of printing media is installed, and so on. The contents of this file change during every print job. While the driver developer provides an initial copy of the status file, it is the job of the driver to update the file. Typically, printer filter programs treat the status file as read- only. <<<<pppprrrriiiinnnntttteeeerrrr nnnnaaaammmmeeee>>>>....lllloooogggg This file contains the print job history for the printer. Information for old jobs as well as the current print job is maintained. Typically, printer filters and drivers PPPPaaaaggggeeee 1111 PPPPOOOODDDD((((4444)))) IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo PPPPOOOODDDD((((4444)))) append information to the log file while general applications treat the file as read-only. GGGGEEEENNNNEEEERRRRAAAALLLL SSSSYYYYNNNNTTTTAAAAXXXX CCCChhhhaaaarrrraaaacccctttteeeerrrr SSSSeeeetttt <space>: 0x09, 0x20 (<sp>, <ht>) <null>: 0x00-0x08, 0x0B, 0x0C, 0x0E-0x1F, 0x7F-0xFF <endline>: 0x0A, 0x0D (<nl>, <cr>) <separator>: 0x7C ('|') <plainchar>: 0x21-0x7B, 0x7D, 0x7E <ddigit>: 0x30-0x39 ('0'-'9') <hdigit>: <ddigit>, 0x41-0x46, 0x61-0x66 ('0'-'9', 'A'-'F', 'a'-'f') <sign>: 0x2B, 0x2D ('+', '-') <point>: 0x2E ('.') FFFFiiiieeeelllldddd FFFFoooorrrrmmmmaaaatttt <white>: <space> [<space>...] <word>: <plainchar> [<plainchar>...] <keyword>: <word> with a specific sequence of <plainchar> <keyfield>: [<white>] <keyword> [[<white> <keyword>]...] [<white>] <string>: [<white>] <word> [[<white> <word>]...] [<white>] <int>: <ddigit> [<ddigit>...] <hbyte>: ["0x" | "0X"] [<hdigit>] <hdigit> <float>: [<sign>] <int> [<point> [<int>]] or [<sign>] <point> <int> <array>: <string> [[<separator> <string>]...] IIIINNNNPPPPUUUUTTTT PPPPAAAARRRRSSSSIIIINNNNGGGG RRRRUUUULLLLEEEESSSS The following rules apply when a POD file is parsed by the _l_i_b_p_o_d API. +o All <null> characters are ignored; their use is not recommended. This provision is intended to avoid errors caused by non-printing characters appearing in the POD files. +o All input lines are truncated to PPPPDDDD____SSSSTTTTRRRR____MMMMAAAAXXXX-1, not counting <null> characters and <endline>, which are removed on input. The value of PPPPDDDD____SSSSTTTTRRRR____MMMMAAAAXXXX is defined in the header file /_u_s_r/_i_n_c_l_u_d_e/_p_o_d._h. +o All occurrences of <white> sequences are reduced to a single <sp> character. In addition, <white> appearing at the beginning or end of a field is removed. +o There are no quoted strings. Quotation marks are treated like any other character, and cannot be used to force additional <white> into a field. +o All fields are checked for correct syntax based on entry type. Failure to provide information in the correct format will result in improper parsing. PPPPaaaaggggeeee 2222 PPPPOOOODDDD((((4444)))) IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo PPPPOOOODDDD((((4444)))) +o When scanning for <int> or <float> numbers within a field, all characters that are not valid within an <int> or <float> are treated as <white> (in the case of an <int>, <sign> and <point> are treated as <white>). This allows characters to be inserted to improve readability. For example, the following are equivalent if two <int> items are expected: 300 300 300 x 300 300 by 300 300,300 +o Entries containing no characters other than <white> prior to the first <separator> or <endline> are treated as null entries and discarded without error. These lines may be used as comments simply by placing a <separator> prior to any other information. +o Blank lines are ignored and may be inserted to improve readability. +o <keyfield> matching is done in a case independent manner. +o Fields designed to be human readable are not modified, except to remove <null> and excess <white>. Case and all <plainchar> sequences are preserved. +o A <keyfield> may require a long list of items (e.g. Available Fonts). To improve readability and avoid the risk of input line buffer overflow, these <keyfield> may be repeated. For example, a list of fifty Available Fonts items may be broken into two Available Fonts entries with 25 items each. The overall number of items that can be specified in a list is limited only by available system memory resources. +o There is no required entry order. The <keyfield> entries may appear in any order within a POD file. +o Default values are assumed for certain fields if values have not been specified. The values of these defaults should not be relied upon and may change in future releases. CCCCOOOONNNNFFFFIIIIGGGG FFFFIIIILLLLEEEE FFFFOOOORRRRMMMMAAAATTTT This section describes the printer configuration file format. The configuration file is installed in /_v_a_r/_s_p_o_o_l/_l_p/_p_o_d with the name <_p_r_i_n_t_e_r _n_a_m_e>._c_o_n_f_i_g. The general format for config file entries is: <keyfield> <separator> [<infofield>] <endline> where <infofield> is specified in the table below. The SSSSiiiizzzzeeee TTTTaaaabbbblllleeee EEEEnnnnttttrrrryyyy <infofield> has the format <sizeentry> defined as: PPPPaaaaggggeeee 3333 PPPPOOOODDDD((((4444)))) IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo PPPPOOOODDDD((((4444)))) <sizeentry>: <keyword> <int> <int> <float> <float> <float> <float> [<hbyte> [<hbyte>]] All entries in the config file are optional. Entries that are not provided or that have no <infofield> specified will be assigned default values. However, since printer capabilities differ, it is recommended that entries be omitted and defaults be used only for entries that are truly inapplicable (e.g. manual feed or quality modes). KKKKeeeeyyyy FFFFiiiieeeelllldddd <<<<iiiinnnnffffooooffffiiiieeeelllldddd>>>> DDDDeeeeffffaaaauuuulllltttt _______________________________________________________________ PPPPrrrriiiinnnntttteeeerrrr CCCCllllaaaassssssss <keyword> Dumb PPPPrrrriiiinnnntttteeeerrrr MMMMooooddddeeeellll <string> Unknown PPPPrrrriiiinnnntttteeeerrrr OOOOppppttttiiiioooonnnnssss <string> (empty string) TTTTeeeecccchhhhnnnnoooollllooooggggyyyy <string> Unknown LLLLooooccccaaaattttiiiioooonnnn CCCCooooddddeeee <keyword> NONE PPPPhhhhyyyyssssiiiiccccaaaallll LLLLooooccccaaaattttiiiioooonnnn <string> Unknown DDDDrrrriiiivvvveeeerrrr PPPPaaaatttthhhh <word> (see description) PPPPoooorrrrtttt PPPPaaaatttthhhh <word> /dev/null AAAAccccttttiiiivvvveeee SSSSttttaaaattttuuuussss PPPPaaaatttthhhh <word> (see description) EEEErrrrrrrroooorrrr RRRReeeettttrrrryyyy WWWWaaaaiiiitttt <int> 10 SSSSttttaaaattttuuuussss UUUUppppddddaaaatttteeee WWWWaaaaiiiitttt <int> 300 MMMMeeeeddddiiiiaaaa WWWWaaaaiiiitttt <int> 300 RRRReeeessssoooolllluuuuttttiiiioooonnnn <int> <int> 300 300 MMMMiiiinnnniiiimmmmuuuummmm PPPPrrrriiiinnnntttt AAAArrrreeeeaaaa <float> <float> (see description) MMMMaaaaxxxxiiiimmmmuuuummmm PPPPrrrriiiinnnntttt AAAArrrreeeeaaaa <float> <float> (see description) MMMMiiiinnnniiiimmmmuuuummmm AAAAddddddddrrrr <int> <int> (see description) MMMMaaaaxxxxiiiimmmmuuuummmm AAAAddddddddrrrr <int> <int> (see description) CCCCoooosssstttt ppppeeeerrrr PPPPaaaaggggeeee <float> 0.0 TTTTiiiimmmmeeee ppppeeeerrrr PPPPaaaaggggeeee <int> [<int>] 0 0 NNNNuuuummmmbbbbeeeerrrr ooooffff CCCCoooolllloooorrrrssss <int> [<int>] 1 1 QQQQuuuuaaaalllliiiittttyyyy MMMMooooddddeeeessss <array> (0 elements) DDDDeeeeffffaaaauuuulllltttt QQQQMMMM <int> 0 MMMMaaaannnnuuuuaaaallll CCCCaaaappppaaaabbbblllleeee <keyword> No BBBBllllaaaacccckkkk SSSSuuuubbbbssssttttiiiittttuuuutttteeee <keyword> No MMMMeeeeddddiiiiaaaa SSSSttttaaaannnnddddaaaarrrrdddd <keyword> American AAAAvvvvaaaaiiiillllaaaabbbblllleeee FFFFoooonnnnttttssss <array> (0 elements) IIIInnnnppppuuuutttt SSSSoooouuuurrrrcccceeee <array> (0 elements) DDDDeeeeffffaaaauuuulllltttt IIIISSSS <int> [,gamma=<float>] 0, gamma=-1.0 CCCCoooolllloooorrrr AAAAddddjjjjuuuussssttttmmmmeeeennnntttt <array> (0 elements) DDDDeeeeffffaaaauuuulllltttt CCCCAAAA <int> 0 MMMMeeeeddddiiiiaaaa TTTTyyyyppppeeee <array> (0 elements) DDDDeeeeffffaaaauuuulllltttt MMMMTTTT <int> 0 SSSSiiiizzzzeeee TTTTaaaabbbblllleeee EEEEnnnnttttrrrryyyy <sizeentry> (see description) _P_r_i_n_t_e_r _C_l_a_s_s Keyword specifying the class of printer. Available values are: DDDDuuuummmmbbbb RRRRaaaasssstttteeeerrrr CCCCoooolllloooorrrrRRRRaaaasssstttteeeerrrr PPPPaaaaggggeeee 4444 PPPPOOOODDDD((((4444)))) IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo PPPPOOOODDDD((((4444)))) CCCCoooolllloooorrrrPPPPoooossssttttSSSSccccrrrriiiipppptttt MMMMoooonnnnooooPPPPoooossssttttSSSSccccrrrriiiipppptttt PPPPllllooootttttttteeeerrrr Obsolete values are: DDDDuuuummmmbbbbCCCCoooolllloooorrrr CCCCoooolllloooorrrr PPPPoooossssttttSSSSccccrrrriiiipppptttt _P_r_i_n_t_e_r _M_o_d_e_l Manufacturer's description of the printer. For example, _T_e_k_t_r_o_n_i_x _P_h_a_s_e_r _I_I _S_X or _A_p_p_l_e _L_a_s_e_r_W_r_i_t_e_r _I_I _N_T_X. _P_r_i_n_t_e_r _O_p_t_i_o_n_s Installed printer options. For example, _8 _M_b_y_t_e_s _R_A_M. _T_e_c_h_n_o_l_o_g_y Printing technology. For example, _i_n_k _j_e_t, _w_a_x _t_r_a_n_s_f_e_r, _d_y_e _s_u_b_l_i_m_a_t_i_o_n, _c_o_l_o_r _l_a_s_e_r. _L_o_c_a_t_i_o_n _C_o_d_e Site specific keyword identifying the printers physical location. For example, 3333UUUU----999922224444. _P_h_y_s_i_c_a_l _L_o_c_a_t_i_o_n Human-readable description of printer's physical location. For example, _B_l_d_g. _3 _U_p_p_e_r, _R_o_o_m _9_2_4. _D_r_i_v_e_r _P_a_t_h Full pathname of printer driver. The default value for this entry is the full pathname of the POD config file with the suffix ._c_o_n_f_i_g removed. _P_o_r_t _P_a_t_h Full pathname of the I/O port to which the printer is physically connected. For example, /_d_e_v/_p_l_p for a parallel printer, /_d_e_v/_t_t_y_d_2 for a serial printer and /_d_e_v/_s_c_s_i/_s_c_0_d_6_l_0 for a SCSI printer. _A_c_t_i_v_e _S_t_a_t_u_s _P_a_t_h Full pathname of the POD status file. The value of this entry is not used by the _l_i_b_p_o_d API. The value of this entry is always set by the API to PPPPDDDDppppoooodddd____ppppaaaatttthhhh/<printer name>.status. Refer to the _l_i_b_p_o_d(_3) man page for additional information. _E_r_r_o_r _R_e_t_r_y _W_a_i_t Number of seconds to wait after an before attempting to resume printing after an error has occurred. _S_t_a_t_u_s _U_p_d_a_t_e _W_a_i_t Number of seconds to between updates of the POD status file when no error has occurred. _M_e_d_i_a _W_a_i_t Number of seconds to wait for manual feed or print media changes before default media source is used. PPPPaaaaggggeeee 5555 PPPPOOOODDDD((((4444)))) IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo PPPPOOOODDDD((((4444)))) _R_e_s_o_l_u_t_i_o_n Maximum horizontal and vertical printer resolution in dots per inch (dpi). For printers that allow multiple resolutions, the status file _P_r_i_n_t_e_r _O_p_t_i_o_n_s entry should be parsed for the CCCCuuuurrrrrrrreeeennnnttttRRRReeeessss keyword. This keyword indicates the current printer resolution. If the keyword is not found, the config file _R_e_s_o_l_u_t_i_o_n entry should be used. _M_i_n_i_m_u_m _P_r_i_n_t _A_r_e_a, _M_a_x_i_m_u_m _P_r_i_n_t _A_r_e_a Minimum and maximum printable area dimensions expressed in inches. The default values for these entries assume an A size page (8.5 by 11.0 inches) in portrait orientation with 0.5 inch margins. This gives a printable area of 7.5 by 10.0 inches (i.e. _7._5 _1_0._0). The minimum and maximum values are identical in the default case. If a Page Size Table has been specified, the values for this entry are derived from it. _M_i_n_i_m_u_m _A_d_d_r, _M_a_x_i_m_u_m _A_d_d_r Minimum and maximum printable area dimensions expressed in dots. The default values for these entries assume an A size page (8.5 by 11.0 inches) in portrait orientation with 0.5 inch margins. At 300 dpi this gives a printable area of 2250 by 3000 dots. The minimum and maximum values are identical in the default case. If a Page Size Table has been specified, the values for this entry are derived from it. _C_o_s_t _p_e_r _P_a_g_e Cost per printed page in local currency. For example, _0._5_0 for 50 cents per page. _T_i_m_e _p_e_r _P_a_g_e The average and, optionally, maximum time to print a page, in seconds. If the maximum time is not provided, it is assumed to be the same as the average time. _N_u_m_b_e_r _o_f _C_o_l_o_r_s The minimum and, optionally, maximum number of colors that are available on the printer. If the maximum number of colors is not provided, it is assumed to be the same as the minimum. A monochrome printer or printer ribbon would provide one color. A CMY printer or ribbon would provide three colors. Note that this field should contain only the number of colors available on the printer. The colorspace, depth and data format are provided in the _N_u_m_b_e_r _o_f _C_o_l_o_r_s entry in the status file. _Q_u_a_l_i_t_y _M_o_d_e_s A list of output quality modes available on the printer. For example, _d_r_a_f_t, and _l_e_t_t_e_r. PPPPaaaaggggeeee 6666 PPPPOOOODDDD((((4444)))) IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo PPPPOOOODDDD((((4444)))) _D_e_f_a_u_l_t _Q_M The index into the _Q_u_a_l_i_t_y _M_o_d_e_s list indicating the default quality mode. This index is based at one rather than zero. Thus, the first quality mode in the list is at position 1, the second at 2, and so on. If there are no quality modes specified, this entry should either be left empty or set to 0. _M_a_n_u_a_l _C_a_p_a_b_l_e Keyword yyyyeeeessss indicating that the printer is capable of being manually fed or nnnnoooo indicating that it is not. Note that for a printer to be considered manual capable its driver must support manual feeding (the -m driver option in the Impressario Filter/Driver Specification) in addition to the printer hardware allowing manual feed. _B_l_a_c_k _S_u_b_s_t_i_t_u_t_e Keyword yyyyeeeessss indicating that the printer should substitute true black for composite black or nnnnoooo indicating that it should not. _M_e_d_i_a _S_t_a_n_d_a_r_d Keyword indicating the paper measurement standard. Keywords are AAAAmmmmeeeerrrriiiiccccaaaannnn or MMMMeeeettttrrrriiiicccc. _A_v_a_i_l_a_b_l_e _F_o_n_t_s This entry contains a list of font names representing the fonts available on the printer. For printers with built-in PostScript interpreters this list should include only those fonts built into the printer (typically a set of 35 standard fonts). For raster printers the PostScript interpretation is performed on the printer host machine. Thus, the fonts listed for these printers should correspond to the names of the font outline files installed on the printer host. There are two methods for specifying the font names. The names can be listed individually or a full path to the directory where the outline fonts are stored can be specified. The two methods can be mixed. When a directory is specified, the names of the files in that directory are assumed to be the names of the fonts. To exclude filenames from the directory, specify the name of the file to be excluded with a leading '!'. The filenames to exclude must appear on the same line as the directory containing the filename to be excluded. The following is a valid Available Fonts list: NewYearRoman | /usr/fonts | !fonts.dir This entry indicates that the fonts available on the printer are NewYearRoman and all filenames in the directory /_u_s_r/_f_o_n_t_s with the exception of fonts.dir. Note that font names must not contain any whitespace. PPPPaaaaggggeeee 7777 PPPPOOOODDDD((((4444)))) IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo PPPPOOOODDDD((((4444)))) To logically AND a list of font names, specify the name of the file or directory (to AND with) using a leading '&'. This is useful when supporting a printer with built-in PostScript. In this case, you would list the fonts supported by the printer and then logically AND that list against the fonts installed on the system. The result is a list of valid fonts that can be used with utilities like text2ps(1) which are also supported by the printer (text2ps(1) requires the font metric be installed on the system so it can generate page and line breaks correctly). The following is a valid Available Fonts list: NewYearRoman | &/usr/lib/DPS/AFM This simple example indicates that the font available on the printer is NewYearRoman and it should be used if the corresponding font is found in /usr/lib/DPS/AFM. _I_n_p_u_t _S_o_u_r_c_e A list of printer input sources. The primary use of this entry is to list the image source devices that have been characterized for printer color correction. A common input device would be the monitor. An Example entry is _S_o_n_y _1_6" _M_o_n_i_t_o_r. _D_e_f_a_u_l_t _I_S The index into the _I_n_p_u_t _S_o_u_r_c_e list indicating the default input source. This index is based at one rather than zero. Thus, the first source in the list is at position 1, the second at 2, and so on. If there are no input sources specified, this entry should either be left empty or set to 0. When used for printer color correction, this entry can also be used to specify the default device's gamma correction value. The gamma value is specified after the default input source index as in the following example: 1, gamma = 1.000 _C_o_l_o_r _A_d_j_u_s_t_m_e_n_t A list of color adjustment methods available for the printer. The color adjustment methods perform color correction between the current input source and the printer. An example entry is: None | Fix Blue | Gamma Correct _D_e_f_a_u_l_t _C_A The index into the _C_o_l_o_r _A_d_j_u_s_t_m_e_n_t list indicating the default adjustment method. This index is based at one rather than zero. Thus, the first method in the list is at position 1, the second at 2, and so on. If there are no adjustment methods specified, this entry PPPPaaaaggggeeee 8888 PPPPOOOODDDD((((4444)))) IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo PPPPOOOODDDD((((4444)))) should either be left empty or set to 0. _M_e_d_i_a _T_y_p_e A list of the output media types supported by the printer. Typical items would be _B_o_n_d _P_a_p_e_r and _T_r_a_n_s_p_a_r_e_n_c_y _F_i_l_m. _D_e_f_a_u_l_t _M_T The index into the _M_e_d_i_a _T_y_p_e list indicating the default media. This index is based at one rather than zero. Thus, the first media in the list is at position 1, the second at 2, and so on. If there are no media types listed, this entry should either be left empty or set to 0. _S_i_z_e _T_a_b_l_e _E_n_t_r_y This entry describes a particular media size that is supported by the printer. Typically these is one _S_i_z_e _T_a_b_l_e _E_n_t_r_y per supported media size (e.g. an entry for A size and B size). The media size entry has seven required fields and two optional fields. All fields are separated by whitespace. The first field contains the media size name keyword (e.g. _A). The list of possible media sizes can be found in the file /_u_s_r/_i_n_c_l_u_d_e/_p_o_d._h. The media size keyword is simply the media size name listed in _p_o_d._h with the PPPPDDDD____SSSSIIIIZZZZEEEE____ prefix removed. The size names listed in _p_o_d._h with the suffix ____LLLLAAAANNNNDDDD indicate landscape orientation and should not not be used as a media size keyword. Media with landscape orientation is indicated by the width and height fields of the size table entry. The next two fields are the media imageable width and height expressed in dots. Typically the imageable dimensions are derived by subtracting the margins from the total media size and converting the result to dots. The next two fields are the overall media width and height expressed in inches. The last two required fields are the left and top margins expressed in inches. The first optional field specifies the printing raster direction. Refer to _p_o_d._h for the values that may be specified in this field. The second optional field is the media validation mask. This mask can be used to differentiate among media entries that have the same media name but differ in other respects (e.g. resolution). The field is a bit mask and so to fully differentiate among PPPPaaaaggggeeee 9999 PPPPOOOODDDD((((4444)))) IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo PPPPOOOODDDD((((4444)))) similar entries the values must be powers of two. Refer to the _P_D_R_e_a_d_I_n_f_o(_3) man page for more information on the use of this field. A default _S_i_z_e _T_a_b_l_e _E_n_t_r_y is always add to the end of the table when it is read by _l_i_b_p_o_d. This default entry is: A 2250 3000 8.500 11.000 0.500 0.500 0x00 0xFF SSSSTTTTAAAATTTTUUUUSSSS FFFFIIIILLLLEEEE FFFFOOOORRRRMMMMAAAATTTT This section describes the printer status file format. The status file is installed in /_v_a_r/_s_p_o_o_l/_l_p/_p_o_d with the name <_p_r_i_n_t_e_r _n_a_m_e>._s_t_a_t_u_s. The general format for config file entries is: <keyfield> <separator> [<infofield>] <endline> where <infofield> is specified by the table below. The NNNNuuuummmmbbbbeeeerrrr ooooffff CCCCoooolllloooorrrrssss <infofield> has the format <dataentry> defined as: <dataentry>: <int> [<keyword> <int> <keyword>] The EEEErrrrrrrroooorrrr, WWWWaaaarrrrnnnniiiinnnngggg and IIIInnnnffffoooorrrrmmmmaaaattttiiiioooonnnn message <infofield> has the format <msgentry> defined as: <msgentry>: <hbyte> [<hbyte> [<hbyte>]] <separator> <string> All entries in the status file are optional. Entries that are not provided or that have no <infofield> will be assigned default values. However, since the status file is the only means to indicate printer status to the user, it is strongly suggested that a complete status file be provided by the developer and that the printer driver update the status file to reflect the printer's current status. KKKKeeeeyyyy FFFFiiiieeeelllldddd <<<<iiiinnnnffffooooffffiiiieeeelllldddd>>>> DDDDeeeeffffaaaauuuulllltttt ______________________________________________________ OOOOppppeeeerrrraaaattttiiiioooonnnnaaaallll SSSSttttaaaattttuuuussss <keyword> Idle MMMMeeeeddddiiiiaaaa SSSSiiiizzzzeeee <keyword> [Land] A MMMMeeeeddddiiiiaaaa TTTTyyyyppppeeee <keyword> Paper NNNNuuuummmmbbbbeeeerrrr ooooffff CCCCoooolllloooorrrrssss <dataentry> 1 k 1 chunky PPPPrrrriiiinnnntttteeeerrrr OOOOppppttttiiiioooonnnnssss <string> (empty string) VVVVaaaalllliiiiddddaaaattttiiiioooonnnn MMMMaaaasssskkkk <hbyte> 0 EEEErrrrrrrroooorrrr <msgentry> (no message) WWWWaaaarrrrnnnniiiinnnngggg <msgentry> (no message) IIIInnnnffffoooorrrrmmmmaaaattttiiiioooonnnn <msgentry> (no message) _O_p_e_r_a_t_i_o_n_a_l _S_t_a_t_u_s Keyword specifying the current operational status of the printer. The possible values are: PPPPaaaaggggeeee 11110000 PPPPOOOODDDD((((4444)))) IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo PPPPOOOODDDD((((4444)))) IIIIddddlllleeee BBBBuuuussssyyyy FFFFaaaauuuulllltttteeeedddd UUUUnnnnaaaavvvvaaaaiiiillllaaaabbbblllleeee The status FFFFaaaauuuulllltttteeeedddd indicates that there is a problem with the printer or with communication to the printer. The UUUUnnnnaaaavvvvaaaaiiiillllaaaabbbblllleeee designation is similar to the FFFFaaaauuuulllltttteeeedddd state and is intended to provide an additional problem description state. _M_e_d_i_a _S_i_z_e Keyword indicating the currently loaded media size. The media size keywords are listed in the file _p_o_d._h. The keyword is the size name listed with the PPPPDDDD____SSSSIIIIZZZZEEEE____ prefix removed. The size names listed in _p_o_d._h with the suffix ____LLLLAAAANNNNDDDD indicate landscape orientation and are specified in the entry by the keyword LLLLaaaannnndddd. _M_e_d_i_a _T_y_p_e This keyword indicates the currently loaded media type. The value is PPPPaaaappppeeeerrrr, TTTTrrrraaaannnnssssppppaaaarrrreeeennnnccccyyyy, OOOOtttthhhheeeerrrr or UUUUnnnnkkkknnnnoooowwwwnnnn. _N_u_m_b_e_r _o_f _C_o_l_o_r_s This field specifies not only the number of output colors but the colorspace, depth and organization of the output data. There are one required and three optional fields. For proper operation of printing filters it is strongly recommended that the optional fields be specified. The first field is required and specifies the number of output colors that the printer can currently print. If only this field is present the following defaults will apply: #### CCCCoooolllloooorrrrssss CCCCoooolllloooorrrr DDDDeeeepppptttthhhh OOOOrrrrgggg.... _________________________________ 1 k 1 chunky 3 cmy 1 chunky 4 cmyk 1 chunky The optional (but recommended) three fields explicitly specify the output colorspace, depth and organization of the output data. The colorspace field is one of: kkkk ccccmmmmyyyy ccccmmmmyyyykkkk wwww rrrrggggbbbb PPPPaaaaggggeeee 11111111 PPPPOOOODDDD((((4444)))) IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo PPPPOOOODDDD((((4444)))) yyyymmmmcccc yyyymmmmcccckkkk kkkkccccmmmmyyyy The depth field specifies the number of bits per color component and may be one of 1111, 4444, 8888. The data organization field is one of: cccchhhhuuuunnnnkkkkyyyy ppppllllaaaannnnaaaarrrr An example output specification is: 3 rgb 4 planar This specifies a three color RGB output with four bits per component (12 bits total) and a planar data organization. Refer to the _l_i_b_s_t_i_f_f(_3) man page for additional information on raster data output formats. _P_r_i_n_t_e_r _O_p_t_i_o_n_s This field can be used to describe currently installed optional equipment or configurations. This field is also used to indicate the current printer resolution for printers that allow multiple output resolutions. To indicate the current resolution the string: CCCCuuuurrrrrrrreeeennnnttttRRRReeeessss ==== <int> x <int> is specified. The first integer is the horizontal resolution in dots per inch and the second integer is the vertical resolution in the same units. The current resolution values are used by printing filters such as the PostScript interpreter _p_s_r_i_p(_1). _V_a_l_i_d_a_t_i_o_n _M_a_s_k The validation mask can be used to select among media size entries in the config file that have the same media name but differ in other respects (e.g. resolution). The field is a bit mask and so to fully differentiate among similar entries the values must be powers of two. The default value, 0, will select the first media entry whose name matches the specified media name. Refer to the _P_D_R_e_a_d_S_t_a_t_u_s(_3) man page for more information on the use of this field. _E_r_r_o_r, _W_a_r_n_i_n_g, _I_n_f_o_r_m_a_t_i_o_n These three entries indicate messages written by the printer driver to provide information to the printer user regarding the state of the printer. The three hex bytes provide a message code. The available message codes are listed in _p_o_d._h (PPPPDDDD____EEEERRRRRRRROOOORRRR____****). The PPPPaaaaggggeeee 11112222 PPPPOOOODDDD((((4444)))) IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo PPPPOOOODDDD((((4444)))) low order three bytes of the codes listed in _p_o_d._h are the codes specified in this field. The high order byte of the code is implied by the first field (i.e. _I_n_f_o_r_m_a_t_i_o_n = 00, _W_a_r_n_i_n_g == 01, _E_r_r_o_r = _0_2). The last field is a string providing the text for the message. There can be up to PPPPDDDD____MMMMEEEESSSSSSSSAAAAGGGGEEEE____MMMMAAAAXXXX (see _p_o_d._h) message entries in a status file. An example of a complete message entry is: Information | 01 00 00 | version: driver = 00.00 LLLLOOOOGGGG FFFFIIIILLLLEEEE FFFFOOOORRRRMMMMAAAATTTT The log file is not currently implemented. Developer's should supply an empty file in /_v_a_r/_s_p_o_o_l/_l_p/_p_o_d with the name <_p_r_i_n_t_e_r _n_a_m_e>._l_o_g. FFFFIIIILLLLEEEESSSS /var/spool/lp/pod/<printer name>.config Configuration file /var/spool/lp/pod/<printer name>.status Status file /var/spool/lp/pod/<printer name>.log Log file SSSSEEEEEEEE AAAALLLLSSSSOOOO libpod(3), podd(1M), libstiff(3), psrip(1) PPPPaaaaggggeeee 11113333